From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sun, 3 Nov 2019 16:19:26 +0000 (+0100)
Subject: Fix doc of font-lock-syntactic-face-function
X-Git-Tag: archive/raspbian/1%29.2+1-2+rpi1^2~5^2~19^2~1140
X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https:/www.github.com/%22bookmarks:///%22http:/www.example.com/cgi/%22https:/www.github.com/%22bookmarks:/?a=commitdiff_plain;h=fc6f1f59fe6b49612cdc1963f9078d062b83fdc7;p=emacs.git

Fix doc of font-lock-syntactic-face-function

* doc/lispref/modes.texi (Syntactic Font Lock): Don't refer to
no-longer-existing OTHER-VARS (bug#17730) and include an example.
---

diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index fda5a106bbe..b7e574740ab 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -3381,13 +3381,23 @@ Table Functions}).
 @defvar font-lock-syntactic-face-function
 If this variable is non-@code{nil}, it should be a function to determine
 which face to use for a given syntactic element (a string or a comment).
-The value is normally set through an @var{other-vars} element in
-@code{font-lock-defaults}.
 
 The function is called with one argument, the parse state at point
 returned by @code{parse-partial-sexp}, and should return a face.  The
 default value returns @code{font-lock-comment-face} for comments and
-@code{font-lock-string-face} for strings (@pxref{Faces for Font Lock}).
+@code{font-lock-string-face} for strings (@pxref{Faces for Font
+Lock}).
+
+This variable is normally set through the ``other'' elements in
+@code{font-lock-defaults}:
+
+@lisp
+(setq-local font-lock-defaults
+            `(,python-font-lock-keywords
+              nil nil nil nil
+              (font-lock-syntactic-face-function
+               . python-font-lock-syntactic-face-function)))
+@end lisp
 @end defvar
 
 @node Multiline Font Lock